<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
    <title>Reference</title>
    <link rel="stylesheet" href="../../../luadoc.css" type="text/css" />
	<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
</head>

<body>
<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->

<div id="main">

<div id="navigation">


<h1>LuaDoc</h1>
<ul>
	
	<li><a href="../../../index.html">Index</a></li>
	
</ul>


<!-- Module list -->



<!-- File list -->

<h1>Files</h1>
<ul>

	<li>
		<a href="../../../files/Luamodo_Dev/Bots/TestBot.html">Luamodo_Dev/Bots/TestBot.lua</a>
	</li>

	<li>
		<a href="../../../files/Luamodo_Dev/Classes/Bot_Class.html">Luamodo_Dev/Classes/Bot_Class.lua</a>
	</li>

	<li><strong>Luamodo_Dev/Classes/Connection_Class.lua</strong></li>
	
	<li>
		<a href="../../../files/Luamodo_Dev/Classes/Extension_Class.html">Luamodo_Dev/Classes/Extension_Class.lua</a>
	</li>

	<li>
		<a href="../../../files/Luamodo_Dev/Extensions/Control.html">Luamodo_Dev/Extensions/Control.lua</a>
	</li>

	<li>
		<a href="../../../files/Luamodo_Dev/Extensions/Stats.html">Luamodo_Dev/Extensions/Stats.lua</a>
	</li>

	<li>
		<a href="../../../files/Luamodo_Dev/Utils/Bot_Utils.html">Luamodo_Dev/Utils/Bot_Utils.lua</a>
	</li>

	<li>
		<a href="../../../files/Luamodo_Dev/Utils/Misc_Utils.html">Luamodo_Dev/Utils/Misc_Utils.lua</a>
	</li>

	<li>
		<a href="../../../files/Luamodo_Dev/main.html">Luamodo_Dev/main.lua</a>
	</li>

</ul>






</div> <!-- id="navigation" -->

<div id="content">

<h1>File <code>Luamodo_Dev/Classes/Connection_Class.lua</code></h1>







<h2>Functions</h2>
<table class="function_list">

	<tr>
	<td class="name" nowrap><a href="#Connection.Event["PRIVMSG"]">Connection.Event["PRIVMSG"]</a>&nbsp;(self, from, text)</td>
	<td class="summary">Tits.</td>
	</tr>

</table>




<h2>Tables</h2>
<table class="table_list">

	<tr>
	<td class="name" nowrap><a href="#Connection">Connection</a></td>
	<td class="summary">Connection.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#Connection_mt">Connection_mt</a></td>
	<td class="summary">Connection metatable.</td>
	</tr>

</table>



<br/>
<br/>




<h2><a name="functions"></a>Functions</h2>
<dl class="function">



<dt><a name="Connection.Event["PRIVMSG"]"></a><strong>Connection.Event["PRIVMSG"]</strong>&nbsp;(self, from, text)</dt>
<dd>
Tits.


<h3>Parameters</h3>
<ul>
	
	<li>
	  self: 
	</li>
	
	<li>
	  from: 
	</li>
	
	<li>
	  text: 
	</li>
	
</ul>








</dd>


</dl>




<h2><a name="tables"></a>Tables</h2>
<dl class="table">

<dt><a name="Connection"></a><strong>Connection</strong></dt>
<dd>Connection. <br> <i>Note</i>: The fields listed below are only available to objects created via Connection:New unless otherwise specified <br>


<em>Fields</em>
<ul>
	
	<li>
	  Event: A list of functions to handle various IRC events, indexed via the event name. Events will not be handled if not present in this table <br><i>Note</i>: Available outside of objects created via Connection:New
	</li>
	
	<li>
	  Format: A list of functions to handle the display a various IRC events, indexed via the event name. Events not present in this table will be displayed in their raw format <br><i>Note</i>: Available outside of objects created via Connection:New
	</li>
	
	<li>
	  LastDisplay: Last connection to display data, used by Connection:Display <br><i>Note</i>: Available outside of objects created via Connection:New
	</li>
	
	<li>
	  Retries: Number of connection retry attempts
	</li>
	
	<li>
	  Server: The server to connect to
	</li>
	
	<li>
	  Port: The port to use
	</li>
	
	<li>
	  ShouldReconnect: Whether it should retry a connection after failure
	</li>
	
	<li>
	  ConnectStatus: Status of the connection
	</li>
	
	<li>
	  Timers: A list of timers
	</li>
	
	<li>
	  Bot: The bot that owns this connection
	</li>
	
	<li>
	  Settings: A table of settings
	</li>
	
	<li>
	  Settings.MaxRetries: Number of connection retries to attempt before giving up
	</li>
	
	<li>
	  Settings.Timeout: Number of seconds to wait for data from the server before deciding the connection has timed out
	</li>
	
	<li>
	  Settings.ChannelQueue: A table of channels to join after a successful connection
	</li>
	
	<li>
	  Settings.AltNames: A table of possible names
	</li>
	
	<li>
	  Settings.Name: The current name used by the connection
	</li>
	
	<li>
	  Settings.NameIndex: The index for Settings.AltNames which holds the current name
	</li>
	
	<li>
	  Settings.AuthCmd: The command to send to the server to authenticate with services
	</li>
	
	<li>
	  Settings.RetryDelay: The number of second to wait between connection retry attempts
	</li>
	
</ul>


</dd>


<dt><a name="Connection_mt"></a><strong>Connection_mt</strong></dt>
<dd>Connection metatable. <br>


<em>Fields</em>
<ul>
	
	<li>
	  __index: Index
	</li>
	
	<li>
	  __type: Type
	</li>
	
</ul>


</dd>


</dl>




</div> <!-- id="content" -->

</div> <!-- id="main" -->

<div id="about">
	<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
</div> <!-- id="about" -->

</div> <!-- id="container" -->	
</body>
</html>
